JavaScript Asinxron Kontekstini O'tkazish: AsyncLocalStorage yordamida So'rovlarni Kuzatish va Davomiylik

Zamonaviy server tomonidagi JavaScript dasturlashda, xususan Node.js bilan ishlashda, asinxron operatsiyalar hamma joyda mavjud. Ushbu asinxron chegaralar bo'ylab holat va kontekstni boshqarish qiyin bo'lishi mumkin. Ushbu blog posti asinxron kontekstni o'tkazish tushunchasini o'rganadi va so'rovlarni kuzatish hamda davomiylikni samarali amalga oshirish uchun AsyncLocalStorage dan qanday foydalanishga e'tibor qaratadi. Biz uning afzalliklari, cheklovlari va real hayotdagi qo'llanilishini ko'rib chiqamiz va uning ishlatilishini namoyish etish uchun amaliy misollar keltiramiz.

Asinxron Kontekstni O'tkazishni Tushunish

Asinxron kontekstni o'tkazish - bu asinxron operatsiyalar davomida kontekst ma'lumotlarini (masalan, so'rov ID'lari, foydalanuvchi autentifikatsiya ma'lumotlari, korrelyatsiya ID'lari) saqlash va tarqatish qobiliyatidir. To'g'ri kontekstni o'tkazmasdan, taqsimlangan tizimlarda so'rovlarni kuzatish, loglarni o'zaro bog'lash va unumdorlik muammolarini tashxislash qiyinlashadi.

Kontekstni boshqarishning an'anaviy yondashuvlari ko'pincha kontekst obyektlarini funksiya chaqiruvlari orqali aniq uzatishga tayanadi, bu esa kodni murakkablashtirishi va xatolarga olib kelishi mumkin. AsyncLocalStorage asinxron operatsiyalar davomida ham bitta ijro konteksti ichida kontekst ma'lumotlarini saqlash va olish usulini taqdim etish orqali ancha qulay yechim taklif qiladi.

AsyncLocalStorage bilan tanishuv

AsyncLocalStorage - bu Node.js'ga o'rnatilgan modul (Node.js v14.5.0 dan boshlab mavjud) bo'lib, u asinxron operatsiya davomida lokal ma'lumotlarni saqlash usulini taqdim etadi. U asosan await chaqiruvlari, promiselar va boshqa asinxron chegaralar bo'ylab saqlanadigan xotira maydonini yaratadi. Bu dasturchilarga kontekst ma'lumotlarini aniq uzatmasdan ularga kirish va o'zgartirish imkonini beradi.

AsyncLocalStorage ning asosiy xususiyatlari:

• Avtomatik Kontekstni O'tkazish: AsyncLocalStorage da saqlangan qiymatlar bir xil ijro konteksti ichidagi asinxron operatsiyalar bo'ylab avtomatik ravishda o'tkaziladi.
• Soddalashtirilgan Kod: Kontekst obyektlarini funksiya chaqiruvlari orqali aniq uzatish zaruratini kamaytiradi.
• Yaxshilangan Kuzatuvchanlik: So'rovlarni kuzatish hamda loglar va metrikalarni o'zaro bog'lashni osonlashtiradi.
• Oqimlar uchun xavfsizlik (Thread-Safety): Joriy ijro konteksti ichida kontekst ma'lumotlariga oqimlar uchun xavfsiz kirishni ta'minlaydi.

AsyncLocalStorage uchun qo'llash holatlari

AsyncLocalStorage turli xil stsenariylarda qimmatlidir, jumladan:

• So'rovlarni Kuzatish: Har bir kiruvchi so'rovga unikal ID tayinlash va uni kuzatish maqsadida so'rovning butun hayotiy davri davomida o'tkazish.
• Autentifikatsiya va Avtorizatsiya: Himoyalangan resurslarga kirish uchun foydalanuvchi autentifikatsiya ma'lumotlarini (masalan, foydalanuvchi ID'si, rollar, ruxsatlar) saqlash.
• Loglash va Audit: Yaxshiroq nosozliklarni tuzatish va audit uchun log xabarlariga so'rovga xos metama'lumotlarni biriktirish.
• Unumdorlik Monitoringi: Unumdorlikni tahlil qilish uchun so'rov ichidagi turli komponentlarning bajarilish vaqtini kuzatish.
• Tranzaksiyalarni Boshqarish: Bir nechta asinxron operatsiyalar bo'ylab tranzaksiya holatini boshqarish (masalan, ma'lumotlar bazasi tranzaksiyalari).

Amaliy Misol: AsyncLocalStorage yordamida So'rovlarni Kuzatish

Keling, oddiy Node.js ilovasida so'rovlarni kuzatish uchun AsyncLocalStorage dan qanday foydalanishni ko'rib chiqaylik. Biz har bir kiruvchi so'rovga unikal ID tayinlaydigan va uni so'rovning butun hayotiy davri davomida mavjud qiladigan middleware yaratamiz.

Kod Misoli

Birinchi, kerakli paketlarni o'rnating (agar kerak bo'lsa):

            npm install uuid express
            

              
                Copy
              
            
          

Mana kod:

            // app.js
const express = require('express');
const { AsyncLocalStorage } = require('async_hooks');
const { v4: uuidv4 } = require('uuid');

const app = express();
const asyncLocalStorage = new AsyncLocalStorage();
const port = 3000;

// Middleware to assign a request ID and store it in AsyncLocalStorage
app.use((req, res, next) => {
  const requestId = uuidv4();
  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('requestId', requestId);
    next();
  });
});

// Simulate an asynchronous operation
async function doSomethingAsync() {
  return new Promise(resolve => {
    setTimeout(() => {
      const requestId = asyncLocalStorage.getStore().get('requestId');
      console.log(`[Async] Request ID: ${requestId}`);
      resolve();
    }, 50);
  });
}

// Route handler
app.get('/', async (req, res) => {
  const requestId = asyncLocalStorage.getStore().get('requestId');
  console.log(`[Route] Request ID: ${requestId}`);
  await doSomethingAsync();
  res.send(`Hello World! Request ID: ${requestId}`);
});

app.listen(port, () => {
  console.log(`App listening at http://localhost:${port}`);
});

            

              
                Copy
              
            
          

Ushbu misolda:

1. Biz AsyncLocalStorage obyektini yaratamiz.
2. uuid kutubxonasi yordamida har bir kiruvchi so'rovga unikal ID tayinlaydigan middleware'ni aniqlaymiz.
3. So'rov ishlovchisini AsyncLocalStorage konteksti ichida bajarish uchun asyncLocalStorage.run() dan foydalanamiz. Bu AsyncLocalStorage da saqlangan har qanday qiymatlar so'rovning butun hayotiy davri davomida mavjud bo'lishini ta'minlaydi.
4. Middleware ichida biz so'rov ID'sini asyncLocalStorage.getStore().set('requestId', requestId) yordamida AsyncLocalStorage ga saqlaymiz.
5. Asinxron operatsiyani simulyatsiya qiladigan va AsyncLocalStorage dan so'rov ID'sini oladigan doSomethingAsync() asinxron funksiyasini aniqlaymiz.
6. Marshrut ishlovchisida biz AsyncLocalStorage dan so'rov ID'sini olamiz va uni javobga qo'shamiz.

Ushbu ilovani ishga tushirib, http://localhost:3000 ga so'rov yuborganingizda, so'rov ID'si ham marshrut ishlovchisida, ham asinxron funksiyada logga chiqarilishini ko'rasiz, bu esa kontekstning to'g'ri o'tkazilganligini namoyish etadi.

Tushuntirish

• AsyncLocalStorage Obyekti: Biz kontekst ma'lumotlarimizni saqlaydigan AsyncLocalStorage obyektini yaratamiz.
• Middleware: Middleware har bir kiruvchi so'rovni ushlab qoladi. U UUID yaratadi va keyin so'rovni qayta ishlashning qolgan qismini ushbu xotira konteksti *ichida* bajarish uchun asyncLocalStorage.run dan foydalanadi. Bu juda muhim; u keyingi barcha amallar saqlangan ma'lumotlarga kira olishini ta'minlaydi.
• asyncLocalStorage.run(new Map(), ...): Bu metod ikkita argument qabul qiladi: yangi, bo'sh Map (kontekstingizga mos keladigan bo'lsa, boshqa ma'lumotlar tuzilmalaridan foydalanishingiz mumkin) va callback funksiya. Callback funksiya asinxron kontekst ichida bajarilishi kerak bo'lgan kodni o'z ichiga oladi. Ushbu callback ichida boshlangan har qanday asinxron operatsiyalar Map da saqlangan ma'lumotlarni avtomatik ravishda meros qilib oladi.
• asyncLocalStorage.getStore(): Bu asyncLocalStorage.run ga uzatilgan Map ni qaytaradi. Biz undan so'rov ID'sini saqlash va olish uchun foydalanamiz. Agar run chaqirilmagan bo'lsa, bu undefined qaytaradi, shuning uchun middleware ichida run ni chaqirish muhim.
• Asinxron Funksiya: doSomethingAsync funksiyasi asinxron operatsiyani simulyatsiya qiladi. Muhimi shundaki, u asinxron bo'lishiga qaramay (setTimeout yordamida), u hali ham so'rov ID'siga kira oladi, chunki u asyncLocalStorage.run tomonidan o'rnatilgan kontekst ichida ishlayapti.

Kengaytirilgan Foydalanish: Loglash Kutubxonalari bilan Birlashtirish

AsyncLocalStorage ni loglash kutubxonalari (masalan, Winston yoki Pino) bilan integratsiya qilish ilovalaringizning kuzatiluvchanligini sezilarli darajada oshirishi mumkin. Log xabarlariga kontekst ma'lumotlarini (masalan, so'rov ID'si, foydalanuvchi ID'si) kiritish orqali siz loglarni osongina o'zaro bog'lashingiz va turli komponentlar bo'ylab so'rovlarni kuzatishingiz mumkin.

Winston bilan Misol

            // logger.js
const winston = require('winston');
const { AsyncLocalStorage } = require('async_hooks');

const asyncLocalStorage = new AsyncLocalStorage();

const logger = winston.createLogger({
  level: 'info',
  format: winston.format.combine(
    winston.format.timestamp(),
    winston.format.printf(({ timestamp, level, message }) => {
      const requestId = asyncLocalStorage.getStore() ? asyncLocalStorage.getStore().get('requestId') : 'N/A';
      return `${timestamp} [${level}] [${requestId}] ${message}`;
    })
  ),
  transports: [
    new winston.transports.Console()
  ]
});

module.exports = {
  logger,
  asyncLocalStorage
};

            

              
                Copy
              
            
          

            // app.js (modified)
const express = require('express');
const { v4: uuidv4 } = require('uuid');
const { logger, asyncLocalStorage } = require('./logger');

const app = express();
const port = 3000;

app.use((req, res, next) => {
  const requestId = uuidv4();
  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('requestId', requestId);
    logger.info(`Incoming request: ${req.url}`); // Log the incoming request
    next();
  });
});

async function doSomethingAsync() {
  return new Promise(resolve => {
    setTimeout(() => {
      logger.info('Doing something async...');
      resolve();
    }, 50);
  });
}

app.get('/', async (req, res) => {
  logger.info('Handling request...');
  await doSomethingAsync();
  res.send('Hello World!');
});

app.listen(port, () => {
  logger.info(`App listening at http://localhost:${port}`);
});

            

              
                Copy
              
            
          

Ushbu misolda:

• Biz Winston logger obyektini yaratamiz va uni har bir log xabariga AsyncLocalStorage dan olingan so'rov ID'sini qo'shadigan qilib sozlaymiz. Asosiy qism - winston.format.printf, u AsyncLocalStorage dan so'rov ID'sini (agar mavjud bo'lsa) oladi. Biz so'rov kontekstidan tashqarida loglashda xatolikka yo'l qo'ymaslik uchun asyncLocalStorage.getStore() mavjudligini tekshiramiz.
• Kiruvchi so'rov URL'sini loglash uchun middleware'ni yangilaymiz.
• Sozlangan logger yordamida xabarlarni loglash uchun marshrut ishlovchisi va asinxron funksiyani yangilaymiz.

Endi barcha log xabarlari so'rov ID'sini o'z ichiga oladi, bu esa so'rovlarni kuzatish va loglarni o'zaro bog'lashni osonlashtiradi.

Alternativ Yondashuvlar: cls-hooked va Async Hooks

AsyncLocalStorage paydo bo'lishidan oldin, asinxron kontekstni o'tkazish uchun cls-hooked kabi kutubxonalar keng qo'llanilgan. cls-hooked o'xshash funksionallikni amalga oshirish uchun Async Hooks (Node.js'ning quyi darajadagi API'si) dan foydalanadi. cls-hooked hali ham keng qo'llanilsa-da, uning o'rnatilgan tabiati va yaxshilangan unumdorligi tufayli odatda AsyncLocalStorage afzal ko'riladi.

Async Hooks (async_hooks)

Async Hooks asinxron operatsiyalarning hayotiy davrini kuzatish uchun quyi darajadagi API'ni taqdim etadi. Garchi AsyncLocalStorage Async Hooks ustiga qurilgan bo'lsa-da, to'g'ridan-to'g'ri Async Hooks'dan foydalanish ko'pincha murakkabroq va unumdorligi pastroq bo'ladi. Async Hooks asinxron hayotiy davr ustidan nozik nazorat talab qilinadigan juda o'ziga xos, ilg'or holatlar uchun ko'proq mos keladi. Mutlaqo zarur bo'lmasa, Async Hooks'dan to'g'ridan-to'g'ri foydalanishdan saqlaning.

Nima uchun cls-hooked o'rniga AsyncLocalStorage afzal?

• O'rnatilgan: AsyncLocalStorage Node.js yadrosining bir qismi bo'lib, tashqi bog'liqliklarga bo'lgan ehtiyojni yo'qotadi.
• Unumdorlik: AsyncLocalStorage optimallashtirilgan realizatsiyasi tufayli odatda cls-hooked ga qaraganda unumdorroq.
• Qo'llab-quvvatlash: O'rnatilgan modul sifatida AsyncLocalStorage Node.js yadro jamoasi tomonidan faol ravishda qo'llab-quvvatlanadi.

E'tiborga Olinadigan Jihatlar va Cheklovlar

AsyncLocalStorage kuchli vosita bo'lsa-da, uning cheklovlaridan xabardor bo'lish muhim:

• Kontekst Chegaralari: AsyncLocalStorage faqat bir xil ijro konteksti ichida kontekstni o'tkazadi. Agar siz turli jarayonlar yoki serverlar o'rtasida ma'lumotlarni uzatayotgan bo'lsangiz (masalan, xabarlar navbati yoki gRPC orqali), siz hali ham kontekst ma'lumotlarini aniq seriyalash va deseriyalashingiz kerak bo'ladi.
• Xotira Oqishi: AsyncLocalStorage ni noto'g'ri ishlatish, agar kontekst ma'lumotlari to'g'ri tozalanmasa, potentsial ravishda xotira oqishiga olib kelishi mumkin. asyncLocalStorage.run() dan to'g'ri foydalanayotganingizga ishonch hosil qiling va AsyncLocalStorage da katta hajmdagi ma'lumotlarni saqlashdan saqlaning.
• Murakkablik: AsyncLocalStorage kontekstni o'tkazishni soddalashtirsa-da, ehtiyotkorlik bilan ishlatilmasa, kodingizga murakkablik qo'shishi mumkin. Jamoangiz uning qanday ishlashini tushunishiga va eng yaxshi amaliyotlarga rioya qilishiga ishonch hosil qiling.
• Global O'zgaruvchilar O'rnini Bosmaydi: AsyncLocalStorage global o'zgaruvchilarning o'rnini bosuvchi vosita *emas*. U aynan bitta so'rov yoki tranzaksiya ichida kontekstni o'tkazish uchun mo'ljallangan. Uni haddan tashqari ko'p ishlatish kuchli bog'langan kodga olib kelishi va testlashni qiyinlashtirishi mumkin.

AsyncLocalStorage'dan foydalanish bo'yicha eng yaxshi amaliyotlar

AsyncLocalStorage dan samarali foydalanish uchun quyidagi eng yaxshi amaliyotlarni ko'rib chiqing:

• Middleware'dan foydalaning: Har bir so'rovning boshida AsyncLocalStorage ni ishga tushirish va kontekst ma'lumotlarini saqlash uchun middleware'dan foydalaning.
• Minimal Ma'lumotlarni Saqlang: Xotira yukini kamaytirish uchun AsyncLocalStorage da faqat muhim kontekst ma'lumotlarini saqlang. Katta obyektlar yoki maxfiy ma'lumotlarni saqlashdan saqlaning.
• To'g'ridan-to'g'ri Kirishdan Saqlaning: Kuchli bog'liqlikdan qochish va kodni qo'llab-quvvatlashni yaxshilash uchun AsyncLocalStorage ga kirishni aniq belgilangan API'lar orqasida inkapsulyatsiya qiling. Kontekst ma'lumotlarini boshqarish uchun yordamchi funksiyalar yoki sinflar yarating.
• Xatolarni Ishlashni Ko'rib Chiqing: AsyncLocalStorage to'g'ri ishga tushirilmagan holatlarni muammosiz hal qilish uchun xatolarni ishlashni joriy qiling.
• Puxta Test Qiling: Kontekstni o'tkazish kutilganidek ishlayotganligiga ishonch hosil qilish uchun birlik va integratsiya testlarini yozing.
• Foydalanishni Hujjatlashtiring: Boshqa dasturchilarga kontekstni o'tkazish mexanizmini tushunishga yordam berish uchun ilovangizda AsyncLocalStorage qanday ishlatilayotganini aniq hujjatlashtiring.

OpenTelemetry bilan Integratsiya

OpenTelemetry - bu telemetriya ma'lumotlarini (masalan, treyslar, metrikalar, loglar) yig'ish va eksport qilish uchun API'lar, SDK'lar va vositalarni taqdim etuvchi ochiq manbali kuzatuvchanlik freymvorkidir. AsyncLocalStorage ni OpenTelemetry bilan muammosiz integratsiya qilish mumkin, bu esa treys kontekstini asinxron operatsiyalar bo'ylab avtomatik ravishda o'tkazish imkonini beradi.

OpenTelemetry turli xizmatlar bo'ylab treyslarni o'zaro bog'lash uchun kontekstni o'tkazishga katta tayanadi. AsyncLocalStorage dan foydalanish orqali siz Node.js ilovangizda treys kontekstining to'g'ri o'tkazilishini ta'minlashingiz mumkin, bu esa keng qamrovli taqsimlangan kuzatuv tizimini yaratishga imkon beradi.

Ko'pgina OpenTelemetry SDK'lari kontekstni o'tkazish uchun avtomatik ravishda AsyncLocalStorage (yoki AsyncLocalStorage mavjud bo'lmasa, cls-hooked) dan foydalanadi. Muayyan tafsilotlar uchun tanlagan OpenTelemetry SDK hujjatlarini tekshiring.

Xulosa

AsyncLocalStorage server tomonidagi JavaScript ilovalarida asinxron kontekstni o'tkazishni boshqarish uchun qimmatli vositadir. Undan so'rovlarni kuzatish, autentifikatsiya, loglash va boshqa qo'llash holatlari uchun foydalanib, siz yanada mustahkam, kuzatiluvchan va qo'llab-quvvatlanishi oson ilovalar yaratishingiz mumkin. Garchi cls-hooked va Async Hooks kabi alternativlar mavjud bo'lsa-da, AsyncLocalStorage o'zining o'rnatilgan tabiati, unumdorligi va foydalanish qulayligi tufayli odatda afzal ko'rilgan tanlovdir. Uning imkoniyatlaridan samarali foydalanish uchun eng yaxshi amaliyotlarga rioya qilishni va uning cheklovlarini yodda tutishni unutmang. Asinxron operatsiyalar bo'ylab so'rovlarni kuzatish va hodisalarni o'zaro bog'lash qobiliyati, ayniqsa mikroxizmatlar arxitekturalari va murakkab taqsimlangan muhitlarda, kengaytiriladigan va ishonchli tizimlarni yaratish uchun juda muhimdir. AsyncLocalStorage dan foydalanish ushbu maqsadga erishishga yordam beradi va natijada nosozliklarni yaxshiroq tuzatish, unumdorlik monitoringi va umumiy ilova sog'lig'iga olib keladi.